<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /* Copyright 2007,2008,2009 John C. Gunther<a name="line.1"></a>
<FONT color="green">002</FONT>     * <a name="line.2"></a>
<FONT color="green">003</FONT>     * Licensed under the Apache License, Version 2.0 (the<a name="line.3"></a>
<FONT color="green">004</FONT>     * "License"); you may not use this file except in compliance<a name="line.4"></a>
<FONT color="green">005</FONT>     * with the License. You may obtain a copy of the License at:<a name="line.5"></a>
<FONT color="green">006</FONT>     * <a name="line.6"></a>
<FONT color="green">007</FONT>     *  http://www.apache.org/licenses/LICENSE-2.0<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     * Unless required by applicable law or agreed to in writing,<a name="line.9"></a>
<FONT color="green">010</FONT>     * software distributed under the License is distributed on an<a name="line.10"></a>
<FONT color="green">011</FONT>     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,<a name="line.11"></a>
<FONT color="green">012</FONT>     * either express or implied. See the License for the specific<a name="line.12"></a>
<FONT color="green">013</FONT>     * language governing permissions and limitations under the<a name="line.13"></a>
<FONT color="green">014</FONT>     * License.<a name="line.14"></a>
<FONT color="green">015</FONT>     */<a name="line.15"></a>
<FONT color="green">016</FONT>    package com.googlecode.gchart.client;<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    /**<a name="line.18"></a>
<FONT color="green">019</FONT>     * Defines the extra features that must be added to a &lt;tt&gt;Widget&lt;/tt&gt;<a name="line.19"></a>
<FONT color="green">020</FONT>     * before it can be used to generate hover feedback.  You can customize<a name="line.20"></a>
<FONT color="green">021</FONT>     * a curve's hover feedback by passing a &lt;tt&gt;Widget&lt;/tt&gt; that<a name="line.21"></a>
<FONT color="green">022</FONT>     * implements this interface to the &lt;tt&gt;setHoverWidget&lt;/tt&gt; method.<a name="line.22"></a>
<FONT color="green">023</FONT>     * &lt;p&gt;<a name="line.23"></a>
<FONT color="green">024</FONT>     *<a name="line.24"></a>
<FONT color="green">025</FONT>     * For example, the chart below uses a &lt;tt&gt;HoverUpdateable Button&lt;/tt&gt;<a name="line.25"></a>
<FONT color="green">026</FONT>     * to both display each point's x,y position, and allow the user to<a name="line.26"></a>
<FONT color="green">027</FONT>     * delete that point (This is Chart #18 in the Chart Gallery. As with<a name="line.27"></a>
<FONT color="green">028</FONT>     * all of these example charts, you'll<a name="line.28"></a>
<FONT color="green">029</FONT>     * need to add the chart to the &lt;tt&gt;RootPanel&lt;/tt&gt; and then invoke<a name="line.29"></a>
<FONT color="green">030</FONT>     * the &lt;tt&gt;update&lt;/tt&gt; method, as shown in the typical GChart<a name="line.30"></a>
<FONT color="green">031</FONT>     * boilerplate &lt;a<a name="line.31"></a>
<FONT color="green">032</FONT>     * href="package-summary.html#typicalgchartboilerplate"&gt;code snippet&lt;/a&gt;<a name="line.32"></a>
<FONT color="green">033</FONT>     * to get this example to actually work).<a name="line.33"></a>
<FONT color="green">034</FONT>     * <a name="line.34"></a>
<FONT color="green">035</FONT>     *<a name="line.35"></a>
<FONT color="green">036</FONT>     * {@code.sample<a name="line.36"></a>
<FONT color="green">037</FONT>     * ../../../../../../gcharttestapp/src/com/googlecode/gchart/gcharttestapp/client/GChartExample18.java}<a name="line.37"></a>
<FONT color="green">038</FONT>     *<a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;p&gt;<a name="line.39"></a>
<FONT color="green">040</FONT>     *<a name="line.40"></a>
<FONT color="green">041</FONT>     * Here's what this chart looks like with the user hovering over the<a name="line.41"></a>
<FONT color="green">042</FONT>     * point at &lt;tt&gt;(5, 10)&lt;/tt&gt;, before they have deleted anything:<a name="line.42"></a>
<FONT color="green">043</FONT>     *<a name="line.43"></a>
<FONT color="green">044</FONT>     * <a name="line.44"></a>
<FONT color="green">045</FONT>     * &lt;p&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>     * <a name="line.46"></a>
<FONT color="green">047</FONT>     * &lt;img<a name="line.47"></a>
<FONT color="green">048</FONT>     * src="{@docRoot}/com/googlecode/gchart/client/doc-files/gchartexample18.png"&gt;<a name="line.48"></a>
<FONT color="green">049</FONT>     *<a name="line.49"></a>
<FONT color="green">050</FONT>     * &lt;p&gt;<a name="line.50"></a>
<FONT color="green">051</FONT>     *<a name="line.51"></a>
<FONT color="green">052</FONT>     * &lt;i&gt;Tip&lt;/i&gt;: If you just need to generate custom HTML that varies<a name="line.52"></a>
<FONT color="green">053</FONT>     * with the hovered over point, it's probably easier to use<a name="line.53"></a>
<FONT color="green">054</FONT>     * a &lt;tt&gt;HoverParameterInterpreter&lt;/tt&gt; rather than a<a name="line.54"></a>
<FONT color="green">055</FONT>     * &lt;tt&gt;HoverUpdateable&lt;/tt&gt; widget. <a name="line.55"></a>
<FONT color="green">056</FONT>     *<a name="line.56"></a>
<FONT color="green">057</FONT>     *<a name="line.57"></a>
<FONT color="green">058</FONT>     * @see GChart.Symbol#setHoverWidget setHoverWidget<a name="line.58"></a>
<FONT color="green">059</FONT>     * @see GChart.Symbol#setHoverLocation setHoverLocation<a name="line.59"></a>
<FONT color="green">060</FONT>     * @see GChart.Symbol#setHoverAnnotationSymbolType setHoverAnnotationSymbolType<a name="line.60"></a>
<FONT color="green">061</FONT>     * @see GChart.Symbol#setHoverXShift setHoverXShift<a name="line.61"></a>
<FONT color="green">062</FONT>     * @see GChart.Symbol#setHoverYShift setHoverYShift<a name="line.62"></a>
<FONT color="green">063</FONT>     * @see HoverParameterInterpreter HoverParameterInterpreter<a name="line.63"></a>
<FONT color="green">064</FONT>     *<a name="line.64"></a>
<FONT color="green">065</FONT>     */ <a name="line.65"></a>
<FONT color="green">066</FONT>    <a name="line.66"></a>
<FONT color="green">067</FONT>    public interface HoverUpdateable {<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>       /**<a name="line.69"></a>
<FONT color="green">070</FONT>        * Frees any resources that the &lt;tt&gt;hoverUpdate&lt;/tt&gt; method may have<a name="line.70"></a>
<FONT color="green">071</FONT>        * allocated when the user first hovered over the point,<a name="line.71"></a>
<FONT color="green">072</FONT>        * thus returning the hoverWidget to a well-defined state:<a name="line.72"></a>
<FONT color="green">073</FONT>        * ready to recieve the next &lt;tt&gt;hoverUpdate&lt;/tt&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>        * without errors, memory leaks, etc.<a name="line.74"></a>
<FONT color="green">075</FONT>        * &lt;p&gt;<a name="line.75"></a>
<FONT color="green">076</FONT>        * <a name="line.76"></a>
<FONT color="green">077</FONT>        * You might think of this method an an "undo" for<a name="line.77"></a>
<FONT color="green">078</FONT>        * this interface's &lt;tt&gt;hoverUpdate&lt;/tt&gt; method.<a name="line.78"></a>
<FONT color="green">079</FONT>        * <a name="line.79"></a>
<FONT color="green">080</FONT>        * &lt;p&gt;<a name="line.80"></a>
<FONT color="green">081</FONT>        *<a name="line.81"></a>
<FONT color="green">082</FONT>        * GChart calls this method whenever the mouse moves away<a name="line.82"></a>
<FONT color="green">083</FONT>        * from a point it was previously hovering over (just before<a name="line.83"></a>
<FONT color="green">084</FONT>        * it hides the hover annotation and removes the hover<a name="line.84"></a>
<FONT color="green">085</FONT>        * selection feedback from that point).<a name="line.85"></a>
<FONT color="green">086</FONT>        * <a name="line.86"></a>
<FONT color="green">087</FONT>        * &lt;p&gt;<a name="line.87"></a>
<FONT color="green">088</FONT>        * <a name="line.88"></a>
<FONT color="green">089</FONT>        * For example, a hover widget that contains a nested<a name="line.89"></a>
<FONT color="green">090</FONT>        * &lt;tt&gt;MenuBar&lt;/tt&gt; might<a name="line.90"></a>
<FONT color="green">091</FONT>        * need to call &lt;tt&gt;setVisible(false)&lt;/tt&gt; on any opened submenus,<a name="line.91"></a>
<FONT color="green">092</FONT>        * because programatically making the main menu invisible (which<a name="line.92"></a>
<FONT color="green">093</FONT>        * GChart will do automatically when you move away from the point)<a name="line.93"></a>
<FONT color="green">094</FONT>        * does &lt;i&gt;not&lt;/i&gt;, as you might have expected, hide all opened<a name="line.94"></a>
<FONT color="green">095</FONT>        * sub-menus. Another possible use for this method is to commit a<a name="line.95"></a>
<FONT color="green">096</FONT>        * series of changes the user made via a form-like hover widget when<a name="line.96"></a>
<FONT color="green">097</FONT>        * the user implicitly "closes" the hover widget by moving the mouse<a name="line.97"></a>
<FONT color="green">098</FONT>        * away from the point (when it makes sense, it's best to commit such changes<a name="line.98"></a>
<FONT color="green">099</FONT>        * on-the-fly, to avoid the potential for lost work).<a name="line.99"></a>
<FONT color="green">100</FONT>        * &lt;p&gt;<a name="line.100"></a>
<FONT color="green">101</FONT>        * <a name="line.101"></a>
<FONT color="green">102</FONT>        * Note that GChart automatically removes (when<a name="line.102"></a>
<FONT color="green">103</FONT>        * &lt;tt&gt;optimizeFormMemory&lt;/tt&gt; is true) or makes invisible (when it's<a name="line.103"></a>
<FONT color="green">104</FONT>        * false) the DOM representation of the hover widget when the mouse<a name="line.104"></a>
<FONT color="green">105</FONT>        * moves away from the hovered over point. So, all you need to worry<a name="line.105"></a>
<FONT color="green">106</FONT>        * about is cleaning up any artifacts generated by this widget's<a name="line.106"></a>
<FONT color="green">107</FONT>        * &lt;tt&gt;hoverUpdate&lt;/tt&gt; method.<a name="line.107"></a>
<FONT color="green">108</FONT>        * &lt;p&gt;<a name="line.108"></a>
<FONT color="green">109</FONT>        *<a name="line.109"></a>
<FONT color="green">110</FONT>        * <a name="line.110"></a>
<FONT color="green">111</FONT>        * &lt;i&gt;Tip&lt;/i&gt;: Most hover widgets, such as those that simply display<a name="line.111"></a>
<FONT color="green">112</FONT>        * information about the hovered over point, don't have anything<a name="line.112"></a>
<FONT color="green">113</FONT>        * that needs to be cleaned up, and thus can just use a do-nothing<a name="line.113"></a>
<FONT color="green">114</FONT>        * &lt;tt&gt;hoverCleanup&lt;/tt&gt; method: <a name="line.114"></a>
<FONT color="green">115</FONT>        * &lt;p&gt;<a name="line.115"></a>
<FONT color="green">116</FONT>        *<a name="line.116"></a>
<FONT color="green">117</FONT>        * &lt;pre&gt;<a name="line.117"></a>
<FONT color="green">118</FONT>        *   public void hoverCleanup(Curve.Point hoveredAwayFrom) {}<a name="line.118"></a>
<FONT color="green">119</FONT>        * &lt;/pre&gt;<a name="line.119"></a>
<FONT color="green">120</FONT>        *<a name="line.120"></a>
<FONT color="green">121</FONT>        * @param hoveredAwayFrom the previously hovered over point that the<a name="line.121"></a>
<FONT color="green">122</FONT>        *     user has just moved the mouse away from (and thus is no<a name="line.122"></a>
<FONT color="green">123</FONT>        *     longer hovering over).<a name="line.123"></a>
<FONT color="green">124</FONT>        *   <a name="line.124"></a>
<FONT color="green">125</FONT>        * @see #hoverUpdate hoverUpdate<a name="line.125"></a>
<FONT color="green">126</FONT>        * <a name="line.126"></a>
<FONT color="green">127</FONT>        */<a name="line.127"></a>
<FONT color="green">128</FONT>       public void hoverCleanup(GChart.Curve.Point hoveredAwayFrom);<a name="line.128"></a>
<FONT color="green">129</FONT>    <a name="line.129"></a>
<FONT color="green">130</FONT>      /** Updates this widget so that it displays appropriate<a name="line.130"></a>
<FONT color="green">131</FONT>          information about the given point.<a name="line.131"></a>
<FONT color="green">132</FONT>          <a name="line.132"></a>
<FONT color="green">133</FONT>          &lt;p&gt;<a name="line.133"></a>
<FONT color="green">134</FONT>          <a name="line.134"></a>
<FONT color="green">135</FONT>          GChart will call this method, as needed, to assure that the hover<a name="line.135"></a>
<FONT color="green">136</FONT>          widget always displays information about the point that the user<a name="line.136"></a>
<FONT color="green">137</FONT>          is currently "touching" with the mouse (the "hovered over" point).<a name="line.137"></a>
<FONT color="green">138</FONT>          In particular, GChart calls &lt;tt&gt;hoverUpdate&lt;/tt&gt; when the mouse<a name="line.138"></a>
<FONT color="green">139</FONT>          first hovers over a point, but it won't call it again if you move<a name="line.139"></a>
<FONT color="green">140</FONT>          the mouse in a way that keeps it hovering over that same point.<a name="line.140"></a>
<FONT color="green">141</FONT>          <a name="line.141"></a>
<FONT color="green">142</FONT>          &lt;p&gt;<a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>          Note that whenever a point's hover annotation (e.g. hover widget)<a name="line.144"></a>
<FONT color="green">145</FONT>          becomes visible, the hit test region for that point is in effect<a name="line.145"></a>
<FONT color="green">146</FONT>          extended to include the rectangular box associated with its hover<a name="line.146"></a>
<FONT color="green">147</FONT>          annotation. This policy creates a "sticky open" feel to hover<a name="line.147"></a>
<FONT color="green">148</FONT>          widgets. Applications that allow the user to interact with the<a name="line.148"></a>
<FONT color="green">149</FONT>          hover widget need to arrange for a "mousemove pathway" (by using<a name="line.149"></a>
<FONT color="green">150</FONT>          methods such as &lt;tt&gt;setBrushSize&lt;/tt&gt; and<a name="line.150"></a>
<FONT color="green">151</FONT>          &lt;tt&gt;setHoverAnnotationSymbolType(ANCHOR_MOUSE)&lt;/tt&gt; ) that allows<a name="line.151"></a>
<FONT color="green">152</FONT>          the user to move the mouse into the hover widget without moving<a name="line.152"></a>
<FONT color="green">153</FONT>          away from the hovered over point (which would otherwise dismiss<a name="line.153"></a>
<FONT color="green">154</FONT>          the hover annotation before the user could interact with it).<a name="line.154"></a>
<FONT color="green">155</FONT>          <a name="line.155"></a>
<FONT color="green">156</FONT>          &lt;p&gt;<a name="line.156"></a>
<FONT color="green">157</FONT>          <a name="line.157"></a>
<FONT color="green">158</FONT>    <a name="line.158"></a>
<FONT color="green">159</FONT>          This method only needs to concern itself with the content and/or<a name="line.159"></a>
<FONT color="green">160</FONT>          size of the widget; GChart will position and change the visibility<a name="line.160"></a>
<FONT color="green">161</FONT>          of the widget appropriately (as defined via the<a name="line.161"></a>
<FONT color="green">162</FONT>          &lt;tt&gt;setHoverLocation&lt;/tt&gt;, &lt;tt&gt;setHoverAnnotationSymbolType&lt;/tt&gt;,<a name="line.162"></a>
<FONT color="green">163</FONT>          &lt;tt&gt;setHoverXShift&lt;/tt&gt; and &lt;tt&gt;setHoverYShift&lt;/tt&gt; methods) as<a name="line.163"></a>
<FONT color="green">164</FONT>          the user moves the mouse over different points on the chart.<a name="line.164"></a>
<FONT color="green">165</FONT>    <a name="line.165"></a>
<FONT color="green">166</FONT>          @param hoveredOver a reference to the point that the mouse<a name="line.166"></a>
<FONT color="green">167</FONT>          has just begun hovering over. <a name="line.167"></a>
<FONT color="green">168</FONT>          &lt;p&gt;<a name="line.168"></a>
<FONT color="green">169</FONT>    <a name="line.169"></a>
<FONT color="green">170</FONT>          @see #hoverCleanup hoverCleanup<a name="line.170"></a>
<FONT color="green">171</FONT>          @see GChart.Symbol#setHoverLocation setHoverLocation<a name="line.171"></a>
<FONT color="green">172</FONT>          @see GChart.Symbol#setHoverAnnotationSymbolType setHoverAnnotationSymbolType<a name="line.172"></a>
<FONT color="green">173</FONT>          @see GChart.Symbol#setHoverXShift setHoverXShift<a name="line.173"></a>
<FONT color="green">174</FONT>          @see GChart.Symbol#setHoverYShift setHoverYShift<a name="line.174"></a>
<FONT color="green">175</FONT>          @see GChart.Symbol#setBrushSize setBrushSize<a name="line.175"></a>
<FONT color="green">176</FONT>          <a name="line.176"></a>
<FONT color="green">177</FONT>      */<a name="line.177"></a>
<FONT color="green">178</FONT>    <a name="line.178"></a>
<FONT color="green">179</FONT>       public void hoverUpdate(GChart.Curve.Point hoveredOver);<a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>       <a name="line.181"></a>
<FONT color="green">182</FONT>    }<a name="line.182"></a>




























































</PRE>
</BODY>
</HTML>
